Skip to content

Initial framework for jablib-examples #14233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 64 commits into
base: main
Choose a base branch
from
Open

Initial framework for jablib-examples #14233

wants to merge 64 commits into from

Conversation

@koppor
Copy link
Member

@koppor koppor commented Nov 5, 2025 •
edited
Loading

With the modularization we got "jablib". Now, its time to offer it as "useful" library.

I tried to write some scripts in JBang, but the API of JabRef was less than OKish, so I refactored.

Aim for this PR:

  • Extract references from PDF
  • DOI to BibTeX --> follow-up PR

Additional Changes

IEEE as explicit rule-based parser available

grafik

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

koppor added 20 commits November 3, 2025 21:43
@koppor
Initial framework for jablib-examples
0bf92ca
@koppor
Rename "serializeAll" to "writeAll"
95fea76
@koppor
Add some @NonNull annotations
0a00748
@koppor
Even more consistent
57bb18d
@koppor
More renamings
16092ba
@koppor
Add convenience constructor
140e900
@koppor
Add some nullable annotations
93db3a3
@koppor
Add cross-links
54e426c
@koppor
Fix typo
de0037d
@koppor
Fix class name
b18a5c8
@koppor
Have BibliographyFromPdfImporter implementing PlainCitationParser
76d922a
@koppor
Add "IEEE" as another rule option
8a3c91e
@koppor
Fix method name (and visibility)
17f6db1
@koppor
Compilefix
38a47a2
@koppor
Fix casing in BibTeX
68d3054
@koppor
Enable LLM to be used to parse references
130f47e
@koppor
Refine code
0d1e03e 
- BibliographyFromPdfImporter is also an PdfImporter
- importDatabase returns ParserResult (for consistency)
@koppor
Move pdf related importers to pdf sub package
4e888bf
@koppor
Initial PdfImporterWithPlainCitationParser
7418e33
@koppor
WIP: ieee_pdf_references_to_bibtex
2c62603
@koppor
Copy link
Member Author

koppor commented Nov 6, 2025

JBang fails are very strange - I think, we can ignore them - and bet that the main branch will be OK

/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/importer/fileformat/pdf/PdfImporter.java:8: error: cannot find symbol
import org.jabref.logic.importer.ParseException;
                                ^
  symbol:   class ParseException
  location: package org.jabref.logic.importer
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/importer/fileformat/pdf/PdfImporter.java:10: error: package org.jabref.logic.l10n does not exist
import org.jabref.logic.l10n.Localization;
                            ^
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/importer/fileformat/pdf/PdfImporter.java:11: error: cannot find symbol

Strange, because org.jabref.logic.importer.ParseException exists - should be fetched from the snapshot build.

InAnYan
InAnYan requested changes Nov 6, 2025
View reviewed changes
Copy link
Member

@InAnYan InAnYan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there are small changes/ideas

@koppor
Copy link
Member Author

koppor commented Nov 6, 2025

Checkstyle fails because JEP 512 is not supported. See checkstyle/checkstyle#17810. Need to work on ignoring this file.

@koppor koppor changed the title [WIP] Initial framework for jablib-examples Initial framework for jablib-examples Nov 6, 2025
@koppor
Copy link
Member Author

koppor commented Nov 6, 2025

IntelliJ Community (2025.2.4) has issues with formatting Markdown code blocks. Therefore, I switched to HTML (fc384e7). My EAP version doesn't have this issue; thus that commit could be reverted as soon as a new IntelliJ version is released.

@koppor koppor enabled auto-merge November 6, 2025 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@InAnYan InAnYan InAnYan approved these changes

Assignees

No one assigned

Labels

component: jablib status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@koppor @InAnYan @Siedlerchr